Skip to main content

ListTemplates

Description

call the ListTemplates interface to query the template list.

Request Method

POST

Request Path

/apsara/route/ROS/ListTemplates

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
Tag.N.KeyBODYstringNoTestKeythe tag key of the template. The value range of n is 1~20. If this value is specified, an empty string is not allowed. supports up to 128 characters, cannot start with aliyun and acs:, and cannot contain http:// or https://.
PageSizeBODYlongNo1the number of rows per page set during paging query. Value range: 1~50. default value: 10.
PageNumberBODYlongNo10page number of the template list. starting value: 1. default value: 1.
regionIdBODYstringYesNo sample value for this parameter.region id
Tag.N.ValueBODYstringNoTestValuethe tag value of the template. The value range of n is 1~20. If this value is specified, it can be an empty string. supports up to 128 characters, cannot start with aliyun and acs:, and cannot contain http:// or https://.
TemplateNameBODYstringNoMyTemplatetemplate name. must be no more than 255 characters in length and must start with a number or an English letter, which can contain numbers, English letters, dashes (-), and underscores (_).
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
TotalCountinteger3total number of templates.
Descriptionstringtest-descriptiontemplate description.
RequestIdstringC3A8413B-1F16-4DED-AC3E-61A00718DE8Arequest ID.
PageSizeinteger10the number of rows per page set during paging query.
PageNumberinteger1page number of the template list. starting value: 1.
CreateTimestring2019-10-15T08:17:14.000000creation time.
UpdateTimestring2019-10-15T08:17:14.000000update time.
Templatesarray of templateNo sample value for this parameter.template list.
TemplateNamestringtest-list-templatestemplate name.
TemplateIdstring4d4f5aa2-3260-4e47-863b-763fbb12****template ID.

Example

Successful Response example

{
"TotalCount":"3",
"Description":"test-description",
"RequestId":"C3A8413B-1F16-4DED-AC3E-61A00718DE8A",
"PageSize":"10",
"PageNumber":"1",
"CreateTime":"2019-10-15T08:17:14.000000",
"UpdateTime":"2019-10-15T08:17:14.000000",
"Templates":"",
"TemplateName":"test-list-templates",
"TemplateId":"4d4f5aa2-3260-4e47-863b-763fbb12****"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}